Playwright Service API (preview:2026-01-01)

2025/12/31 • 8 new methods

Workspaces_Get (new)
Description :  Get details of the Azure resource mapped to a workspace for the given workspace id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Playwright workspace is the parent resource for most of the other service resources. ,
}
{
id:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
resourceId:
{
Description: The fully-qualified Azure resource id for the workspace. ,
Required: True ,
}
string ,
name:
{
Description: The workspace name. ,
Required: True ,
}
string ,
state:
{
Description: The state of workspace - Active | Inactive ,
Enum:
{
Active: The workspace is Active. ,
Inactive: The workspace is Inactive. ,
}
,
Required: True ,
}
enum ,
subscriptionId:
{
Description: The Azure subscription id in GUID format for the workspace. ,
Required: True ,
}
string ,
subscriptionState:
{
Description: The Azure subscription state - Registered | Unregistered | Warned | Suspended | Deleted ,
Enum:
{
Registered: The subscription state is Registered. ,
Warned: The subscription state is Warned. ,
Suspended: The subscription state is Suspended. ,
Deleted: The subscription state is Deleted. ,
Unregistered: The subscription state is Unregistered. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The Azure tenant id in GUID format for the workspace. ,
Required: True ,
}
string ,
location:
{
Description: The workspace resource location in Azure, for eg. eastus, southeastasia. ,
Required: True ,
}
string ,
regionalAffinity:
{
Description: This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created. ,
Enum:
{
Enabled: The feature is Enabled. ,
Disabled: The feature is Disabled. ,
}
,
Required: False ,
}
enum ,
localAuth:
{
Description: When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations. ,
Enum:
{
Enabled: The feature is Enabled. ,
Disabled: The feature is Disabled. ,
}
,
Required: False ,
}
enum ,
storageUri:
{
Description: When set on Playwright workspace resource, it provides the URI of the Azure storage account used to store workspace artifacts, test results, and reports. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_List (new)
Description :  Lists access tokens for the specified workspace ID. Supports OData query parameters: $select, $filter, $orderby, $top, and $skip. Default page size is 10. Use nextLink in response to fetch additional results. Requires Bearer JWT access token provided by Entra ID.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/access-tokens
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of AccessToken items ,
}
{
value:
{
Description: The AccessToken items on this page ,
Required: True ,
}
[
{
id:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access token creation timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access token expiration timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access token state. ,
Enum:
{
Active: The access token is active and can be used for authentication. ,
Expired: The access token has expired and cannot be used for authentication. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_Get (new)
Description :  Gets an access token for the workspace with the specified access token ID. Requires Bearer JWT access token provided by Entra ID.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access token linked to a workspace. ,
}
{
id:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access token creation timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access token expiration timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access token state. ,
Enum:
{
Active: The access token is active and can be used for authentication. ,
Expired: The access token has expired and cannot be used for authentication. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_CreateOrReplace (new)
Description :  Creates an access token for the workspace with the specified access token ID and name. The ID and name must be unique among active access tokens for the user within a Playwright workspace. Requires Bearer JWT access token provided by Entra ID.
Reference :  Link ¶

⚼ Request

PUT:  /playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access token creation timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access token expiration timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access token state. ,
Enum:
{
Active: The access token is active and can be used for authentication. ,
Expired: The access token has expired and cannot be used for authentication. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access token linked to a workspace. ,
}
{
id:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access token creation timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access token expiration timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access token state. ,
Enum:
{
Active: The access token is active and can be used for authentication. ,
Expired: The access token has expired and cannot be used for authentication. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access token linked to a workspace. ,
}
{
id:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
name:
{
Description: The access token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access token creation timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access token expiration timestamp in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access token state. ,
Enum:
{
Active: The access token is active and can be used for authentication. ,
Expired: The access token has expired and cannot be used for authentication. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_Delete (new)
Description :  Deletes an access token for the workspace with the specified access token ID. Requires Bearer JWT access token provided by Entra ID.
Reference :  Link ¶

⚼ Request

DELETE:  /playwrightworkspaces/{workspaceId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access token ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Workspaces_GetBrowsers (new)
Description :  Gets remote browsers for the specified workspace ID and redirects the client to execute Playwright scripts. Requires Bearer JWT access token provided by Entra ID or Playwright Service.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/browsers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
os:
{
Description: The operating system for remote script execution. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID in GUID format. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
}

⚐ Response (302)

{
location:
{
Description: The redirect target URL for executing Playwright scripts on remote browsers. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TestRuns_List (new)
Description :  Lists test runs for the specified workspace ID. Supports OData query parameters such as $filter and $top. Default page size is 10. Use nextLink in response to fetch additional results. Requires Bearer JWT access token provided by Entra ID or Playwright Service.
Reference :  Link ¶

⚼ Request

GET:  /playwrightworkspaces/{workspaceId}/test-runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of TestRun items ,
}
{
value:
{
Description: The TestRun items on this page ,
Required: True ,
}
[
{
id:
{
Description: The test run ID in GUID format. ,
Required: True ,
}
string ,
displayName:
{
Description: The test run display name. ,
Required: True ,
}
string ,
creatorId:
{
Description: The test run creator's ID. ,
Required: True ,
}
string ,
creatorName:
{
Description: The test run creator's name. ,
Required: False ,
}
string ,
config:
{
Description: The test run configuration. ,
Required: False ,
}
{
framework:
{
Description: The framework used for the test run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK language used for the test run. ,
Enum:
{
JAVASCRIPT: JavaScript SDK ,
TYPESCRIPT: TypeScript SDK ,
CSHARP: C# SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test run CI configuration. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch name. ,
Required: False ,
}
string ,
author:
{
Description: The CI commit author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit ID. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
summary:
{
Description: The test run summary. ,
Required: True ,
}
{
status:
{
Description: The test run status. ,
Enum:
{
RUNNING: The test run is currently running. ,
CLIENT_COMPLETE: The test run has completed on the client side. ,
SERVER_COMPLETE: The test run has completed on the server side. ,
}
,
Required: True ,
}
enum ,
billableTime:
{
Description: The test run billable time in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
numBrowserSessions:
{
Description: The total number of browser sessions allocated to the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
maxConcurrentBrowserSessions:
{
Description: The highest number of browser sessions that were running concurrently during the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The test run start time in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The test run end time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
errorMessages:
{
Description: The list of error messages corresponding to the test run. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TestRuns_CreateOrUpdate (new)
Description :  Creates or updates a test run for the workspace with the specified test run ID. Requires Bearer JWT access token provided by Entra ID or Playwright Service.
Reference :  Link ¶

⚼ Request

PATCH:  /playwrightworkspaces/{workspaceId}/test-runs/{runId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
workspaceId:
{
Description: The workspace ID in GUID format. ,
Required: True ,
}
string ,
runId:
{
Description: The test run ID in GUID format. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-useragent:
{
Description: Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format. ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
displayName:
{
Description: The test run display name. ,
Required: False ,
}
string ,
config:
{
Description: The test run configuration. ,
Required: False ,
}
{
framework:
{
Description: The framework used for the test run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK language used for the test run. ,
Enum:
{
JAVASCRIPT: JavaScript SDK ,
TYPESCRIPT: TypeScript SDK ,
CSHARP: C# SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test run CI configuration. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch name. ,
Required: False ,
}
string ,
author:
{
Description: The CI commit author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit ID. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of a test run used for tracking purposes. ,
}
{
id:
{
Description: The test run ID in GUID format. ,
Required: True ,
}
string ,
displayName:
{
Description: The test run display name. ,
Required: True ,
}
string ,
creatorId:
{
Description: The test run creator's ID. ,
Required: True ,
}
string ,
creatorName:
{
Description: The test run creator's name. ,
Required: False ,
}
string ,
config:
{
Description: The test run configuration. ,
Required: False ,
}
{
framework:
{
Description: The framework used for the test run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK language used for the test run. ,
Enum:
{
JAVASCRIPT: JavaScript SDK ,
TYPESCRIPT: TypeScript SDK ,
CSHARP: C# SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test run CI configuration. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch name. ,
Required: False ,
}
string ,
author:
{
Description: The CI commit author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit ID. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
summary:
{
Description: The test run summary. ,
Required: True ,
}
{
status:
{
Description: The test run status. ,
Enum:
{
RUNNING: The test run is currently running. ,
CLIENT_COMPLETE: The test run has completed on the client side. ,
SERVER_COMPLETE: The test run has completed on the server side. ,
}
,
Required: True ,
}
enum ,
billableTime:
{
Description: The test run billable time in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
numBrowserSessions:
{
Description: The total number of browser sessions allocated to the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
maxConcurrentBrowserSessions:
{
Description: The highest number of browser sessions that were running concurrently during the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The test run start time in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The test run end time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
errorMessages:
{
Description: The list of error messages corresponding to the test run. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of a test run used for tracking purposes. ,
}
{
id:
{
Description: The test run ID in GUID format. ,
Required: True ,
}
string ,
displayName:
{
Description: The test run display name. ,
Required: True ,
}
string ,
creatorId:
{
Description: The test run creator's ID. ,
Required: True ,
}
string ,
creatorName:
{
Description: The test run creator's name. ,
Required: False ,
}
string ,
config:
{
Description: The test run configuration. ,
Required: False ,
}
{
framework:
{
Description: The framework used for the test run. ,
Required: False ,
}
{
name:
{
Description: The framework name. ,
Required: False ,
}
string ,
version:
{
Description: The framework version. ,
Required: False ,
}
string ,
runnerName:
{
Description: The framework runner name. ,
Required: False ,
}
string ,
}
,
sdkLanguage:
{
Description: The SDK language used for the test run. ,
Enum:
{
JAVASCRIPT: JavaScript SDK ,
TYPESCRIPT: TypeScript SDK ,
CSHARP: C# SDK ,
}
,
Required: False ,
}
enum ,
maxWorkers:
{
Description: The maximum number of workers required for the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
ciConfig:
{
Description: The test run CI configuration. ,
Required: False ,
}
{
providerName:
{
Description: The CI provider name. ,
Required: False ,
}
string ,
branch:
{
Description: The CI branch name. ,
Required: False ,
}
string ,
author:
{
Description: The CI commit author. ,
Required: False ,
}
string ,
commitId:
{
Description: The CI commit ID. ,
Required: False ,
}
string ,
revisionUrl:
{
Description: The CI revision URL. ,
Required: False ,
}
string ,
}
,
summary:
{
Description: The test run summary. ,
Required: True ,
}
{
status:
{
Description: The test run status. ,
Enum:
{
RUNNING: The test run is currently running. ,
CLIENT_COMPLETE: The test run has completed on the client side. ,
SERVER_COMPLETE: The test run has completed on the server side. ,
}
,
Required: True ,
}
enum ,
billableTime:
{
Description: The test run billable time in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
numBrowserSessions:
{
Description: The total number of browser sessions allocated to the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
maxConcurrentBrowserSessions:
{
Description: The highest number of browser sessions that were running concurrently during the test run. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: The test run start time in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The test run end time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
errorMessages:
{
Description: The list of error messages corresponding to the test run. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}